GedcomX.addSourceDescription - Code Metrics - Inspection of "add missing attributes on GedcomX; close #17" - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 09bd06...74e15e )

by Justin

created 2016-09-22 19:04 UTC

GedcomX.addSourceDescription A

↳ Parent: src/GedcomX.js

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

var ExtensibleData = require('./ExtensibleData'),
    Person = require('./Person'),
    Relationship = require('./Relationship'),
    SourceDescription = require('./SourceDescription'),
    Agent = require('./Agent'),
    Event = require('./Event'),
    Document = require('./Document'),
    PlaceDescription = require('./PlaceDescription'),
    Attribution = require('./Attribution'),
    utils = require('./utils');

/**
 * A GEDCOM X document.
 * 
 * @constructor
 * @param {Object} [json]

 */
var GedcomX = function(json){
  
  // Protect against forgetting the new keyword when calling the constructor
  if(!(this instanceof GedcomX)){
    return new GedcomX(json);
  }
  
  // If the given object is already an instance then just return it. DON'T copy it.
  if(GedcomX.isInstance(json)){
    return json;
  }
  
  ExtensibleData.call(this, json);
  
  if(json){
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
    this.setLang(json.lang);
    this.setPersons(json.persons);
    this.setRelationships(json.relationships);
    this.setSourceDescriptions(json.sourceDescriptions);
    this.setAgents(json.agents);
    this.setEvents(json.events);
    this.setDocuments(json.documents);
    this.setPlaces(json.places);
    this.setAttribution(json.attribution);
    this.setDescription(json.description);

  }
};

GedcomX.prototype = Object.create(ExtensibleData.prototype);

GedcomX._gedxClass = GedcomX.prototype._gedxClass = 'GedcomX';

/**
 * Check whether the given object is an instance of this class.
 * 
 * @param {Object} obj
 * @returns {Boolean}
 */
GedcomX.isInstance = function(obj){
  return utils.isInstance(obj, this._gedxClass);
};

/**
 * Get the lang
 * 
 * @return {String}
 */
GedcomX.prototype.getLang = function(){
  return this.lang;
};

/**
 * Set the lang
 * 
 * @param {String} lang
 * @return {GedcomX} This instance
 */
GedcomX.prototype.setLang = function(lang){
  if(lang){
    this.lang = lang;
  }
  return this;
};

/**
 * Get the description
 * 
 * @return {String}
 */
GedcomX.prototype.getDescription = function(){
  return this.description;
};

/**
 * Set the description
 * 
 * @param {String} description URI that must resolve to a SourceDescription
 * @return {GedcomX} This instance
 */
GedcomX.prototype.setDescription = function(description){
  if(description){
    this.description = description;
  }
  return this;
};

/**
 * Get the persons
 * 
 * @returns {Person[]}
 */
GedcomX.prototype.getPersons = function(){
  return this.persons || [];
};

/**
 * Set the persons
 * 
 * @param {Person[]|Object[]} persons
 * @returns {GedcomX} This instance
 */
GedcomX.prototype.setPersons = function(persons){
  return this._setArray(persons, 'persons', 'addPerson');
};

/**
 * Add a person
 * 
 * @param {Person|Object}

 * @returns {GedcomX} This instance
 */
GedcomX.prototype.addPerson = function(person){
  return this._arrayPush(person, 'persons', Person);
};

/**
 * Get the relationships
 * 
 * @returns {Relationship[]}
 */
GedcomX.prototype.getRelationships = function(){
  return this.relationships || [];
};

/**
 * Set the relationships
 * 
 * @param {Relationship[]|Object[]} relationships
 * @returns {GedcomX}
 */
GedcomX.prototype.setRelationships = function(relationships){
  return this._setArray(relationships, 'relationships', 'addRelationship');
};

/**
 * Add a relationship
 * 
 * @param {Relationship|Object} relationship
 * @returns {GedcomX}
 */
GedcomX.prototype.addRelationship = function(relationship){
  return this._arrayPush(relationship, 'relationships', Relationship);
};

/**
 * Get the source descriptions
 * 
 * @returns {SourceDescription[]}
 */
GedcomX.prototype.getSourceDescriptions = function(){
  return this.sourceDescriptions || [];
};

/**
 * Set the source descriptions
 * 
 * @param {SourceDescription[]|Object[]} sourceDescriptions
 * @returns {GedcomX}
 */
GedcomX.prototype.setSourceDescriptions = function(sourceDescriptions){
  return this._setArray(sourceDescriptions, 'sourceDescriptions', 'addSourceDescription');
};

/**
 * Add a ource description
 * 
 * @param {SourceDescription|Object} sourceDescription
 * @returns {GedcomX}
 */
GedcomX.prototype.addSourceDescription = function(sourceDescription){
  return this._arrayPush(sourceDescription, 'sourceDescriptions', SourceDescription);
};

/**
 * Get the agents
 * 
 * @returns {Agent[]}
 */
GedcomX.prototype.getAgents = function(){
  return this.agents || [];
};

/**
 * Set the agents
 * 
 * @param {Agent[]|Object[]} agents
 * @returns {GedcomX}
 */
GedcomX.prototype.setAgents = function(agents){
  return this._setArray(agents, 'agents', 'addAgent');
};

/**
 * Add an agent
 * 
 * @param {Agent|Object}

 * @returns {GedcomX}
 */
GedcomX.prototype.addAgent = function(agent){
  return this._arrayPush(agent, 'agents', Agent);
};

/**
 * Get events
 * 
 * @returns {Event[]}
 */
GedcomX.prototype.getEvents = function(){
  return this.events || [];
};

/**
 * Set events
 * 
 * @param {Event[]|Object[]} events
 * @returns {GedcomX}
 */
GedcomX.prototype.setEvents = function(events){
  return this._setArray(events, 'events', 'addEvent');
};

/**
 * Add an event
 * 
 * @param {Event|Object} event
 * @returns {GedcomX}
 */
GedcomX.prototype.addEvent = function(event){
  return this._arrayPush(event, 'events', Event);
};

/**
 * Get the documents
 * 
 * @returns {Document[]}
 */
GedcomX.prototype.getDocuments = function(){
  return this.documents || [];
};

/**
 * Set the documents
 * 
 * @param {Documents[]|Object[]} documents
 * @returns {GedcomX}
 */
GedcomX.prototype.setDocuments = function(documents){
  return this._setArray(documents, 'documents', 'addDocument');
};

/**
 * Add a document
 * 
 * @param {Document|Object} doc
 * @returns {GedcomX}
 */
GedcomX.prototype.addDocument = function(doc){
  return this._arrayPush(doc, 'documents', Document);
};

/**
 * Get places
 * 
 * @returns {PlaceDescription[]}
 */
GedcomX.prototype.getPlaces = function(){
  return this.places || [];
};

/**
 * Set the places
 * 
 * @param {PlaceDescription[]|Object} places
 * @returns {GedcomX}
 */
GedcomX.prototype.setPlaces = function(places){
  return this._setArray(places, 'places', 'addPlace');
};

/**
 * Add a place
 * 
 * @param {PlaceDescription} place
 * @returns {GedcomX}
 */
GedcomX.prototype.addPlace = function(place){
  return this._arrayPush(place, 'places', PlaceDescription);
};

/**
 * Get attritbution
 * 
 * @returns {Attribution}
 */
GedcomX.prototype.getAttribution = function(){
  return this.attribution;
};

/**
 * Set attribution
 * 
 * @param {Attribution} attribution
 * @returns {GedcomX}
 */
GedcomX.prototype.setAttribution = function(attribution){
  if(attribution){
    this.attribution = Attribution(attribution);
  }
  return this;
};

/**
 * Export the object as JSON
 * 
 * @return {Object} JSON object
 */
GedcomX.prototype.toJSON = function(){
  return this._toJSON(ExtensibleData, [
    'lang',
    'description',
    'persons',
    'relationships',
    'sourceDescriptions',
    'agents',
    'events',
    'documents',
    'places',
    'attribution'
  ]);
};

// Expose all classes
GedcomX.Address = require('./Address');
GedcomX.Agent = Agent;
GedcomX.Attribution = Attribution;
GedcomX.Conclusion = require('./Conclusion');
GedcomX.Coverage = require('./Coverage');
GedcomX.Date = require('./Date');
GedcomX.Document = Document;
GedcomX.Event = Event;
GedcomX.EventRole = require('./EventRole');
GedcomX.EvidenceReference = require('./EvidenceReference');
GedcomX.ExtensibleData = ExtensibleData;
GedcomX.Fact = require('./Fact');
GedcomX.Gender = require('./Gender');
GedcomX.Identifiers = require('./Identifiers');
GedcomX.Name = require('./Name');
GedcomX.NameForm = require('./NameForm');
GedcomX.NamePart = require('./NamePart');
GedcomX.Note = require('./Note');
GedcomX.OnlineAccount = require('./OnlineAccount');
GedcomX.Person = Person;
GedcomX.PlaceDescription = PlaceDescription;
GedcomX.PlaceReference = require('./PlaceReference');
GedcomX.Qualifier = require('./Qualifier');
GedcomX.Relationship = Relationship;
GedcomX.ResourceReference = require('./ResourceReference');
GedcomX.SourceCitation = require('./SourceCitation');
GedcomX.SourceDescription = SourceDescription;
GedcomX.SourceReference = require('./SourceReference');
GedcomX.Subject = require('./Subject');
GedcomX.TextValue = require('./TextValue');

module.exports = GedcomX;

1			var ExtensibleData = require('./ExtensibleData'),
2			Person = require('./Person'),
3			Relationship = require('./Relationship'),
4			SourceDescription = require('./SourceDescription'),
5			Agent = require('./Agent'),
6			Event = require('./Event'),
7			Document = require('./Document'),
8			PlaceDescription = require('./PlaceDescription'),
9			Attribution = require('./Attribution'),
10			utils = require('./utils');
11
12			/**
13			* A GEDCOM X document.
14			*
15			* @constructor
16			* @param {Object} [json]
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `[json]` does not exist. Did you maybe forget to remove this comment? Loading history...
17			*/
18			var GedcomX = function(json){
19
20			// Protect against forgetting the new keyword when calling the constructor
21			if(!(this instanceof GedcomX)){
22			return new GedcomX(json);
23			}
24
25			// If the given object is already an instance then just return it. DON'T copy it.
26			if(GedcomX.isInstance(json)){
27			return json;
28			}
29
30			ExtensibleData.call(this, json);
31
32			if(json){
			0 ignored issues – show Complexity Best Practice introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report There is no return statement if `json` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
33			this.setLang(json.lang);
34			this.setPersons(json.persons);
35			this.setRelationships(json.relationships);
36			this.setSourceDescriptions(json.sourceDescriptions);
37			this.setAgents(json.agents);
38			this.setEvents(json.events);
39			this.setDocuments(json.documents);
40			this.setPlaces(json.places);
41			this.setAttribution(json.attribution);
42			this.setDescription(json.description);
			0 ignored issues – show Best Practice introduced 2016-09-22 19:06 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
43			}
44			};
45
46			GedcomX.prototype = Object.create(ExtensibleData.prototype);
47
48			GedcomX._gedxClass = GedcomX.prototype._gedxClass = 'GedcomX';
49
50			/**
51			* Check whether the given object is an instance of this class.
52			*
53			* @param {Object} obj
54			* @returns {Boolean}
55			*/
56			GedcomX.isInstance = function(obj){
57			return utils.isInstance(obj, this._gedxClass);
58			};
59
60			/**
61			* Get the lang
62			*
63			* @return {String}
64			*/
65			GedcomX.prototype.getLang = function(){
66			return this.lang;
67			};
68
69			/**
70			* Set the lang
71			*
72			* @param {String} lang
73			* @return {GedcomX} This instance
74			*/
75			GedcomX.prototype.setLang = function(lang){
76			if(lang){
77			this.lang = lang;
78			}
79			return this;
80			};
81
82			/**
83			* Get the description
84			*
85			* @return {String}
86			*/
87			GedcomX.prototype.getDescription = function(){
88			return this.description;
89			};
90
91			/**
92			* Set the description
93			*
94			* @param {String} description URI that must resolve to a SourceDescription
95			* @return {GedcomX} This instance
96			*/
97			GedcomX.prototype.setDescription = function(description){
98			if(description){
99			this.description = description;
100			}
101			return this;
102			};
103
104			/**
105			* Get the persons
106			*
107			* @returns {Person[]}
108			*/
109			GedcomX.prototype.getPersons = function(){
110			return this.persons \|\| [];
111			};
112
113			/**
114			* Set the persons
115			*
116			* @param {Person[]\|Object[]} persons
117			* @returns {GedcomX} This instance
118			*/
119			GedcomX.prototype.setPersons = function(persons){
120			return this._setArray(persons, 'persons', 'addPerson');
121			};
122
123			/**
124			* Add a person
125			*
126			* @param {Person\|Object}
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
127			* @returns {GedcomX} This instance
128			*/
129			GedcomX.prototype.addPerson = function(person){
130			return this._arrayPush(person, 'persons', Person);
131			};
132
133			/**
134			* Get the relationships
135			*
136			* @returns {Relationship[]}
137			*/
138			GedcomX.prototype.getRelationships = function(){
139			return this.relationships \|\| [];
140			};
141
142			/**
143			* Set the relationships
144			*
145			* @param {Relationship[]\|Object[]} relationships
146			* @returns {GedcomX}
147			*/
148			GedcomX.prototype.setRelationships = function(relationships){
149			return this._setArray(relationships, 'relationships', 'addRelationship');
150			};
151
152			/**
153			* Add a relationship
154			*
155			* @param {Relationship\|Object} relationship
156			* @returns {GedcomX}
157			*/
158			GedcomX.prototype.addRelationship = function(relationship){
159			return this._arrayPush(relationship, 'relationships', Relationship);
160			};
161
162			/**
163			* Get the source descriptions
164			*
165			* @returns {SourceDescription[]}
166			*/
167			GedcomX.prototype.getSourceDescriptions = function(){
168			return this.sourceDescriptions \|\| [];
169			};
170
171			/**
172			* Set the source descriptions
173			*
174			* @param {SourceDescription[]\|Object[]} sourceDescriptions
175			* @returns {GedcomX}
176			*/
177			GedcomX.prototype.setSourceDescriptions = function(sourceDescriptions){
178			return this._setArray(sourceDescriptions, 'sourceDescriptions', 'addSourceDescription');
179			};
180
181			/**
182			* Add a ource description
183			*
184			* @param {SourceDescription\|Object} sourceDescription
185			* @returns {GedcomX}
186			*/
187			GedcomX.prototype.addSourceDescription = function(sourceDescription){
188			return this._arrayPush(sourceDescription, 'sourceDescriptions', SourceDescription);
189			};
190
191			/**
192			* Get the agents
193			*
194			* @returns {Agent[]}
195			*/
196			GedcomX.prototype.getAgents = function(){
197			return this.agents \|\| [];
198			};
199
200			/**
201			* Set the agents
202			*
203			* @param {Agent[]\|Object[]} agents
204			* @returns {GedcomX}
205			*/
206			GedcomX.prototype.setAgents = function(agents){
207			return this._setArray(agents, 'agents', 'addAgent');
208			};
209
210			/**
211			* Add an agent
212			*
213			* @param {Agent\|Object}
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
214			* @returns {GedcomX}
215			*/
216			GedcomX.prototype.addAgent = function(agent){
217			return this._arrayPush(agent, 'agents', Agent);
218			};
219
220			/**
221			* Get events
222			*
223			* @returns {Event[]}
224			*/
225			GedcomX.prototype.getEvents = function(){
226			return this.events \|\| [];
227			};
228
229			/**
230			* Set events
231			*
232			* @param {Event[]\|Object[]} events
233			* @returns {GedcomX}
234			*/
235			GedcomX.prototype.setEvents = function(events){
236			return this._setArray(events, 'events', 'addEvent');
237			};
238
239			/**
240			* Add an event
241			*
242			* @param {Event\|Object} event
243			* @returns {GedcomX}
244			*/
245			GedcomX.prototype.addEvent = function(event){
246			return this._arrayPush(event, 'events', Event);
247			};
248
249			/**
250			* Get the documents
251			*
252			* @returns {Document[]}
253			*/
254			GedcomX.prototype.getDocuments = function(){
255			return this.documents \|\| [];
256			};
257
258			/**
259			* Set the documents
260			*
261			* @param {Documents[]\|Object[]} documents
262			* @returns {GedcomX}
263			*/
264			GedcomX.prototype.setDocuments = function(documents){
265			return this._setArray(documents, 'documents', 'addDocument');
266			};
267
268			/**
269			* Add a document
270			*
271			* @param {Document\|Object} doc
272			* @returns {GedcomX}
273			*/
274			GedcomX.prototype.addDocument = function(doc){
275			return this._arrayPush(doc, 'documents', Document);
276			};
277
278			/**
279			* Get places
280			*
281			* @returns {PlaceDescription[]}
282			*/
283			GedcomX.prototype.getPlaces = function(){
284			return this.places \|\| [];
285			};
286
287			/**
288			* Set the places
289			*
290			* @param {PlaceDescription[]\|Object} places
291			* @returns {GedcomX}
292			*/
293			GedcomX.prototype.setPlaces = function(places){
294			return this._setArray(places, 'places', 'addPlace');
295			};
296
297			/**
298			* Add a place
299			*
300			* @param {PlaceDescription} place
301			* @returns {GedcomX}
302			*/
303			GedcomX.prototype.addPlace = function(place){
304			return this._arrayPush(place, 'places', PlaceDescription);
305			};
306
307			/**
308			* Get attritbution
309			*
310			* @returns {Attribution}
311			*/
312			GedcomX.prototype.getAttribution = function(){
313			return this.attribution;
314			};
315
316			/**
317			* Set attribution
318			*
319			* @param {Attribution} attribution
320			* @returns {GedcomX}
321			*/
322			GedcomX.prototype.setAttribution = function(attribution){
323			if(attribution){
324			this.attribution = Attribution(attribution);
325			}
326			return this;
327			};
328
329			/**
330			* Export the object as JSON
331			*
332			* @return {Object} JSON object
333			*/
334			GedcomX.prototype.toJSON = function(){
335			return this._toJSON(ExtensibleData, [
336			'lang',
337			'description',
338			'persons',
339			'relationships',
340			'sourceDescriptions',
341			'agents',
342			'events',
343			'documents',
344			'places',
345			'attribution'
346			]);
347			};
348
349			// Expose all classes
350			GedcomX.Address = require('./Address');
351			GedcomX.Agent = Agent;
352			GedcomX.Attribution = Attribution;
353			GedcomX.Conclusion = require('./Conclusion');
354			GedcomX.Coverage = require('./Coverage');
355			GedcomX.Date = require('./Date');
356			GedcomX.Document = Document;
357			GedcomX.Event = Event;
358			GedcomX.EventRole = require('./EventRole');
359			GedcomX.EvidenceReference = require('./EvidenceReference');
360			GedcomX.ExtensibleData = ExtensibleData;
361			GedcomX.Fact = require('./Fact');
362			GedcomX.Gender = require('./Gender');
363			GedcomX.Identifiers = require('./Identifiers');
364			GedcomX.Name = require('./Name');
365			GedcomX.NameForm = require('./NameForm');
366			GedcomX.NamePart = require('./NamePart');
367			GedcomX.Note = require('./Note');
368			GedcomX.OnlineAccount = require('./OnlineAccount');
369			GedcomX.Person = Person;
370			GedcomX.PlaceDescription = PlaceDescription;
371			GedcomX.PlaceReference = require('./PlaceReference');
372			GedcomX.Qualifier = require('./Qualifier');
373			GedcomX.Relationship = Relationship;
374			GedcomX.ResourceReference = require('./ResourceReference');
375			GedcomX.SourceCitation = require('./SourceCitation');
376			GedcomX.SourceDescription = SourceDescription;
377			GedcomX.SourceReference = require('./SourceReference');
378			GedcomX.Subject = require('./Subject');
379			GedcomX.TextValue = require('./TextValue');
380
381			module.exports = GedcomX;

rootsdev / gedcomx-js

Push — master ( 09bd06...74e15e )

GedcomX.addSourceDescription A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like